Detect New Devices Commands

System: Detect New Devices

Detect New Devices (DETECTDEVS via script) is a system-level command that triggers the service to search for new EFM devices in your system according to user-defined criteria, and then automatically create new FMS Nodes of the corresponding device type (gas meter, chromatograph, or liquid device) and configuration settings (collection method, supported data group types, etc.) appropriate for the device. These settings are created according to user-specified parameters. You also have the option to choose to poll the device once the Node is created.

You must have proper security authorization to execute this command. See FMS Security (and NODE security event) for information about configuring security access for FMS commands.

See FMS ActiveX Controls and CxHmiFms for more information about using commands via FMS ActiveX controls on CygNet Studio or CygNet Vision screens.

See CxFms for more information about scripting commands.

Managing Detect New Devices Commands

Prior to running Detect New Devices commands, verify or configure the automatic device detection criteria and Node creation parameters. Detect New Devices command options are configured by users with proper security access, via the Extended Options button on the FMS Explorer Commands menu. See Configuring Detect New Devices Options for more information.

Command Definition Properties

The following command definition properties apply to Detect New Devices commands, when scheduling, creating, or editing commands via CygNet Explorer.

Property	Description
FMS service	Select a Site.Service for the command from the available FMS service list in the drop-down menu.
Command	Select the desired Command name from the drop-down menu. See FMS Commands for more information about available command types.
Priority	Select a processing queue Priority for the command from the drop-down menu. Options from least to greatest priority are as follows. Low level Medium level High level User initiated transaction Admin initiated transaction Default value is Low level processing queue priority.
Logging	Select a Logging level for the command results from the drop-down menu. Options are as follows. Low - displays errors Medium - displays errors and warnings High - displays errors, warnings, and status Default value is Low level logging when scheduling a command via the MSS service in CygNet Explorer. Default value is High level logging when creating or running an ad-hoc command in FMS Explorer or via the FMS service in CygNet Explorer.

Property

Description

FMS service

Select a Site.Service for the command from the available FMS service list in the drop-down menu.

Command

Select the desired Command name from the drop-down menu.

See FMS Commands for more information about available command types.

Priority

Select a processing queue Priority for the command from the drop-down menu.

Options from least to greatest priority are as follows.

Low level
Medium level
High level
User initiated transaction
Admin initiated transaction

Default value is Low level processing queue priority.

Logging

Select a Logging level for the command results from the drop-down menu.

Options are as follows.

Low - displays errors
Medium - displays errors and warnings
High - displays errors, warnings, and status

Default value is Low level logging when scheduling a command via the MSS service in CygNet Explorer.

Default value is High level logging when creating or running an ad-hoc command in FMS Explorer or via the FMS service in CygNet Explorer.

Command Parameters

Note: Additional Detect New Devices options are defined through the FMS Explorer Commands menu via the Extended Options button, prior to running the command. See Configuring Detect New Devices Options for more information.

The following command parameters apply to Detect New Devices commands, when scheduling, creating, or editing commands via CygNet Explorer or scripting.

Parameter	Description	Type	Required	Usage Notes
MaxRunTime	Maximum runtime (minutes)	Integer	Optional	If used, double-click to access the Enter Maximum Run Time dialog box. Type the number of minutes after which the request will timeout if it hasn't been completed. If the runtime of the command exceeds this limit, then the command will be terminated and the search for new devices will stop. Default value is 30 minutes. Note: If Node creation is in progress, the Node creation process for the current device will be completed before the command is terminated.
MxPollWait	Maximum wait time for poll (minutes)	Integer	Optional	If used, double-click to access the Enter Max Wait Time for Poll dialog box. Type the maximum time (in minutes) to wait for a configuration poll. If the wait time for the configuration poll exceeds this limit, then it will stop requesting the configuration. Default value is 5 minutes. Note: This wait time parameter does NOT apply to the extended command option to automatically Execute FMS config poll after Node is created for each new Node; those polls are separate automatically triggered commands used as part of the device definition.

Parameter

Description

Type

Required

Usage Notes

MaxRunTime

Maximum runtime (minutes)

Integer

Optional

If used, double-click to access the Enter Maximum Run Time dialog box.

Type the number of minutes after which the request will timeout if it hasn't been completed.

If the runtime of the command exceeds this limit, then the command will be terminated and the search for new devices will stop.

Default value is 30 minutes.

Note: If Node creation is in progress, the Node creation process for the current device will be completed before the command is terminated.

MxPollWait

Maximum wait time for poll (minutes)

Integer

Optional

If used, double-click to access the Enter Max Wait Time for Poll dialog box.

Type the maximum time (in minutes) to wait for a configuration poll.

If the wait time for the configuration poll exceeds this limit, then it will stop requesting the configuration.

Default value is 5 minutes.

Note: This wait time parameter does NOT apply to the extended command option to automatically Execute FMS config poll after Node is created for each new Node; those polls are separate automatically triggered commands used as part of the device definition.